home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_gnats.idb / usr / freeware / lib / gnats / contrib / tkgnats / tkquerypr.1.z / tkquerypr.1
Encoding:
Text File  |  1999-04-16  |  5.4 KB  |  193 lines
  1. \." $Id: tkquerypr.1,v 1.3 1993/11/16 22:19:43 jason Exp $
  2. .TH tkquerypr
  3. .SH NAME
  4. tkquerypr \- 
  5. X Window query interface to the GNATS problem report  database
  6.  
  7. .SH SYNOPSIS
  8. \fBtkquerypr\fP
  9.  
  10. .SH DESCRIPTION
  11. \fBtkquerypr\fP is an X Window query interface to the \fBGNATS\fP
  12. problem report database. It allows you: 
  13. .RS
  14. .in .5in
  15. .PP
  16. - Query the \fBGNATS\fP database
  17. .PP
  18. - Edit items returned from a query.
  19. .PP
  20. - Print items returned from a query.
  21. .PP
  22. - Print a summary report of all items returned from a query
  23. .RE
  24.  
  25. .SH USER INTERFACE
  26. \fBtkquerypr\fP Has four sections arranged from top to bottom. 
  27. They are:
  28. .RS
  29. .in +0.5in
  30. .PP
  31. - A message bar.
  32. .PP
  33. - The query specification section.
  34. .PP
  35. - The query list menubar
  36. .PP
  37. - The query list output box
  38. .RE
  39.  
  40. .RS 
  41. \fBThe message bar\fP
  42. .PP
  43. .in +0.5in
  44. The \fBmessage bar\fP is at the top of the tkquerypr
  45. window. The left half is a message button that spins when a query is in process.
  46. Right half is a message widget that prints out various status messages
  47. generated by tkquerypr.
  48. Clicking on the mesage button will read the current selection and try to
  49. retrieve the PR included in the selection. A common use of this button
  50. is to cut a PR number out of a mail item and query for it with the working 
  51. button.
  52. .RE
  53.  
  54. .RS 
  55. \fBThe query list output box\fP
  56. .PP
  57. .in +0.5in
  58. The \fBquery list output box\fP is at the bottom of the tkquerypr
  59. window. It is a scrolling list that contains the output of any query 
  60. initiated by the query list menubar. Double clicking on a list entry
  61. will bring up the configured editor (see tkconfig.cf.t) for that PR.
  62. The default editor is the \fBtkeditpr\fP.
  63.  
  64. .PP
  65. The \fB<Right>\fR and \fB<Left>\fR Keys scroll the listbox left and right 
  66. to left and right halves of the listbox.
  67.  
  68. \fB<Control-l>\fR and \fB<Control-r>\fR performs the same operations 
  69. for you touch typists out there.
  70. .RE
  71.  
  72. .RS 
  73. \fBThe query list menu bar box\fP
  74. .PP
  75. .in +0.5in
  76. \fBThe query list menu bar\fP is used to initiate queries and to perform
  77. various operations on lists already generated. What follows is a description
  78. of each pull down menu available on the menu bar
  79.  
  80. .RS
  81. .in +0.5in
  82. .PP
  83. The \fBfolder\fP menu\fITO BE DONE... \fP
  84. .PP
  85. The \fBprint\fP menu \fI TO BE DONE... \fP
  86. .PP
  87. The \fBquery\fP menu \fI TO BE DONE... \fP
  88. .PP
  89. The \fBselection\fP menu \fI TO BE DONE... \fP
  90. .RE
  91.  
  92. .RE
  93.  
  94. .RS 
  95. \fBThe Query Specification section\fP
  96. .PP
  97. .in +0.5in
  98. This section allows the user to define what should be returned by a query
  99. performed in the menu bar section. It is subdivided into three parts.
  100.  
  101. The first part of this section is comprised of rows of check
  102. buttons. Each Row corresponds to an enumerated field in \fBGNATS\fP
  103. PR.  Each button in a row describes one of the possible values for the
  104. PR field.  If you turn on a check button if forms an \fBor\fP clause
  105. for that particular PR field.  Take the \fBState:\fP checkbutton row
  106. for example. If you click on the \fIanalyzed\fP and \fIfeedback\fP buttons
  107. and then execute the \fBquery\fP-->\fIperform_query\fP menu item you will
  108. get back all PR's in the database that have a State of 
  109. \fIanalyzed\fP \fBor\fP \fIfeedback\fP. 
  110.  
  111. The second part of this section contains a pair of listboxes that are
  112. used to select what \fBCategories\fP to select. The left listbox
  113. contains all available unselected categories.  The right listbox
  114. contains what categories are currently selected.  LeftButton Clicking
  115. on any item in either of the boxes moves the item from it's current
  116. place in one listbox to the end of the other listbox.
  117.  
  118. \fINote:\fP
  119. Tkquerypr ignores categories that start with an underscore '_'. This is so
  120. you can have have categories that are hidden from TkGnats if you
  121. desire.
  122.  
  123. The third part is some text entry fields. 
  124.  
  125. The Responsible: field allows you to define
  126. a list of values the query should be restricted to in terms of the 
  127. \fBGNATS\fP \fBResponsible\fP field. 
  128. For example, if you type \fImh,andy\fP into this field then only queries
  129. that have \fImh\fP \fBOR\fP \fIandy\fP in the \fBResponsible\fP field 
  130. will be returned.
  131.  
  132. .RS
  133. .in .5in
  134. The Synopsis: field allows you to define
  135. a list of values the query should be restricted to in terms of the 
  136. \fBGNATS\fP \fBSynopsis\fP field. the text expected is a comma seperated list
  137. if \fBcsh\fP pattern matching strings.
  138. .RE
  139.  
  140. .RS
  141. .in .5in
  142. For example, if you type \fI*sun*,*sparc*\fP into this field then only entries
  143. that have \fIsun\fP \fBAND\fP \fIsparc\fP somewhere in the \fBSynopsis\fP 
  144. field will be returned.
  145. .RE
  146. .RE
  147.  
  148. .SH REQUIREMENTS
  149. \fBTkquerypr\fP assumes the following programs 
  150. are present somewhere within the users search \fB$PATH\fP.
  151. .RS
  152. .in .5in
  153. .PP
  154. \fB(g)tbl\fP - For producing PostScript format printed reports
  155. .PP
  156. \fB(g)roff\fP - For producing PostScript format printed reports
  157. .PP
  158. \fBquery-pr\fP - For querying the \fBGNATS\fP database with
  159. .PP
  160. \fBtkeditpr\fP - tkgnats PR editor
  161. .PP
  162. \fBtkviewpr\fP - tkgnats PR viewer
  163. .PP
  164. \fBmsgDialog\fP - tkgnats utility display information dialogs
  165. .PP
  166. .RE
  167. Many of these required programs can be redefined to something
  168. functionally similar by editing the  \fBtkgnats.cf.t\fP configuration
  169. file that is part of the tkgnats release.
  170.  
  171. .SH SEE ALSO
  172. gnats(l), query-pr(l), The GNATS info file
  173.  
  174. .SH BUGS
  175. No doubt they exist. 
  176. You can send mail to the author if you have a bug to report
  177.  
  178. .SH TODO
  179. .PP
  180. Allow user to define their own report processing
  181. .PP
  182. Finish the save_query facility
  183. .PP
  184. Allow the user to define how queries are sorted
  185.  
  186. .SH AUTHOR
  187. Mike Hoegeman
  188.  
  189. .SH CORRESPONDENCE
  190. Email can be sent to the author at the following address.
  191. .PP
  192. \fImh@wx.gtegsc.com\fP
  193.